Improve support `@constraint` annotation mapping to OpenAPI spec #1541

SachinAkash01 · 2023-09-16T20:07:23Z

Add support for mapping Ballerina constraints (Int, Float, Number) to the OpenAPI specification.
Add unit tests to ensure the accuracy & reliability of @constraint mapping to OpenAPI spec.
This ensures that Int, Float & Number constraints in Ballerina are accurately reflected in OpenAPI spec.

Resolves: #4796
See also: #4788

@constraint

* Add support for mapping Ballerina constraints (Int, Float, Number) to the OpenAPI specification. * Add unit tests to ensure the accuracy & reliability of @constraint mapping to OpenAPI spec. * This ensures that Int, Float & Number constraints in Ballerina are accurately reflected in OpenAPI spec. Resolves: #4796 See also: #4788

@constraint

* Add support for mapping Ballerina constraints (Int, Float, Number) to the OpenAPI specification. * Add unit tests to ensure the accuracy & reliability of @constraint mapping to OpenAPI spec. * This ensures that Int, Float & Number constraints in Ballerina are accurately reflected in OpenAPI spec. Resolves: #4796 See also: #4788

CLAassistant · 2023-09-16T20:07:28Z

All committers have signed the CLA.

...i-bal-service/src/main/java/io/ballerina/openapi/converter/service/ConstraintAnnotation.java

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/decimalMax.bal

openapi-cli/src/test/resources/ballerina-to-openapi/expected_gen/constraint/decimalMax.yaml

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java

…en/constraint/decimalMax.yaml Co-authored-by: Ayesh Almeida <[email protected]>

…APIComponentMapper.java

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java

…onstraintValuesToSchema()

…/openapi-tools into constraint_support # Conflicts: # openapi-bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java # openapi-cli/src/test/resources/ballerina-to-openapi/constraint/decimalMax.bal # openapi-cli/src/test/resources/ballerina-to-openapi/constraint/decimalMin.bal # openapi-cli/src/test/resources/ballerina-to-openapi/constraint/floatMax.bal # openapi-cli/src/test/resources/ballerina-to-openapi/constraint/floatMin.bal # openapi-cli/src/test/resources/ballerina-to-openapi/constraint/integerMax.bal # openapi-cli/src/test/resources/ballerina-to-openapi/constraint/integerMin.bal # openapi-cli/src/test/resources/ballerina-to-openapi/expected_gen/constraint/decimalMax.yaml # openapi-cli/src/test/resources/ballerina-to-openapi/expected_gen/constraint/decimalMin.yaml # openapi-cli/src/test/resources/ballerina-to-openapi/expected_gen/constraint/floatMax.yaml # openapi-cli/src/test/resources/ballerina-to-openapi/expected_gen/constraint/floatMin.yaml # openapi-cli/src/test/resources/ballerina-to-openapi/expected_gen/constraint/integerMax.yaml # openapi-cli/src/test/resources/ballerina-to-openapi/expected_gen/constraint/integerMin.yaml

…onstraintValuesToSchema()

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/floatMax.bal

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java

…er/service/OpenAPIComponentMapper.java Co-authored-by: Dilan Sachintha Nayanajith <[email protected]>

…/openapi-tools into constraint_support

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/integerMin.bal

sonarqubecloud · 2023-09-19T08:13:10Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

codecov · 2023-09-19T10:13:40Z

Codecov Report

❗ No coverage uploaded for pull request base (constraint_support@c7cf4fb). Click here to learn what that means.
Patch has no changes to coverable lines.

Additional details and impacted files

@@                  Coverage Diff                  @@
##             constraint_support    #1541   +/-   ##
=====================================================
  Coverage                      ?   79.14%           
  Complexity                    ?     1788           
=====================================================
  Files                         ?      125           
  Lines                         ?    10136           
  Branches                      ?     1681           
=====================================================
  Hits                          ?     8022           
  Misses                        ?     1522           
  Partials                      ?      592

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

SachinAkash01 added 2 commits September 17, 2023 01:15

SachinAkash01 requested review from hevayo, NipunaRanasinghe and lnash94 as code owners September 16, 2023 20:07

ayeshLK reviewed Sep 17, 2023

View reviewed changes

...i-bal-service/src/main/java/io/ballerina/openapi/converter/service/ConstraintAnnotation.java Outdated Show resolved Hide resolved

ayeshLK changed the base branch from master to constraint_support September 17, 2023 17:43

ayeshLK reviewed Sep 17, 2023

View reviewed changes

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/decimalMax.bal Show resolved Hide resolved

ayeshLK reviewed Sep 17, 2023

View reviewed changes

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/decimalMax.bal Outdated Show resolved Hide resolved

ayeshLK reviewed Sep 17, 2023

View reviewed changes

openapi-cli/src/test/resources/ballerina-to-openapi/expected_gen/constraint/decimalMax.yaml Outdated Show resolved Hide resolved

ayeshLK reviewed Sep 17, 2023

View reviewed changes

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java Outdated Show resolved Hide resolved

SachinAkash01 and others added 16 commits September 17, 2023 23:48

Update License Header on decimalMax.bal

78c8af1

Update openapi-cli/src/test/resources/ballerina-to-openapi/expected_g…

64adfaa

…en/constraint/decimalMax.yaml Co-authored-by: Ayesh Almeida <[email protected]>

Update License Header on decimalMin.bal

78a82d7

Update License Header on floatMax.bal

5ed8777

Update License Header on floatMin.bal

35e99c3

Update License Header on integerMax.bal

7db9f2c

Update License Header on integerMin.bal

ef843a7

New line in the end on decimalMin.yaml

1c418bf

Update decimalMin.yaml

5041827

Update decimalMin.yaml

8ec04a4

New line in the end on floatMax.yaml

aafd47f

Update floatMax.yaml

5b32a8f

New line in the end on floatMin.yaml

6137db1

New line in the end on integerMax.yaml

18eae13

New line in the end on integerMin.yaml

7b49fff

Update: importing only relevant classes from the java package in Open…

a673877

…APIComponentMapper.java

ayeshLK reviewed Sep 18, 2023

View reviewed changes

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java Outdated Show resolved Hide resolved

Remove try-catch block, throw ParseException, and refactor setNumberC…

7775636

…onstraintValuesToSchema()

SachinAkash01 added 3 commits September 18, 2023 09:49

Remove try-catch block, throw ParseException, and refactor setNumberC…

bdbe39b

…onstraintValuesToSchema()

Resolve checkstyle violations

d77b8b5

TharmiganK reviewed Sep 18, 2023

View reviewed changes

Nuvindu reviewed Sep 18, 2023

View reviewed changes

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java Show resolved Hide resolved

dilanSachi reviewed Sep 18, 2023

View reviewed changes

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java Outdated Show resolved Hide resolved

dilanSachi reviewed Sep 18, 2023

View reviewed changes

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java Outdated Show resolved Hide resolved

Nuvindu reviewed Sep 18, 2023

View reviewed changes

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java Outdated Show resolved Hide resolved

SachinAkash01 and others added 7 commits September 18, 2023 10:48

Update openapi-bal-service/src/main/java/io/ballerina/openapi/convert…

e512220

…er/service/OpenAPIComponentMapper.java Co-authored-by: Dilan Sachintha Nayanajith <[email protected]>

Tests for the record field type

a7a1f03

Merge branch 'constraint_support' of https://github.com/SachinAkash01…

7bf0af5

…/openapi-tools into constraint_support

Resolve [1541#discussion_r1328249916](ballerina-platform#1541 (comment))

409420e

Remove additional lines above annotations on type definitions

ef22c05

Resolve line spaces

1f639ce

Refactor: Change return type to void in setConstraintValueToSchema()

1c6cc89

lnash94 reviewed Sep 18, 2023

View reviewed changes

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java Show resolved Hide resolved

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/integerMin.bal Show resolved Hide resolved

SachinAkash01 added 2 commits September 18, 2023 21:30

Update float and decimal return type tests in ResponseTests.java

1d419c6

To-Do comment: error handling on integer constraints

df172ed

SachinAkash01 requested review from lnash94 and dilanSachi September 19, 2023 06:15

Fix Tests: ModuleReferenceTests

956107b

lnash94 mentioned this pull request Sep 20, 2023

[BallerinaToOpenAPI] Fix support @constraint annotation mapping for Ballerina to OpenAPI #1043

Closed

1 task

ayeshLK merged commit 53ca54f into ballerina-platform:constraint_support Sep 20, 2023
5 checks passed

ayeshLK mentioned this pull request Sep 20, 2023

Map Ballerina Number Constraints to OpenAPI Specification ballerina-platform/ballerina-library#4796

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve support `@constraint` annotation mapping to OpenAPI spec #1541

Improve support `@constraint` annotation mapping to OpenAPI spec #1541

SachinAkash01 commented Sep 16, 2023 •

edited

Loading

CLAassistant commented Sep 16, 2023 •

edited

Loading

sonarqubecloud bot commented Sep 19, 2023

codecov bot commented Sep 19, 2023

Improve support @constraint annotation mapping to OpenAPI spec #1541

Improve support @constraint annotation mapping to OpenAPI spec #1541

Conversation

SachinAkash01 commented Sep 16, 2023 • edited Loading

CLAassistant commented Sep 16, 2023 • edited Loading

sonarqubecloud bot commented Sep 19, 2023

codecov bot commented Sep 19, 2023

Codecov Report

Improve support `@constraint` annotation mapping to OpenAPI spec #1541

Improve support `@constraint` annotation mapping to OpenAPI spec #1541

SachinAkash01 commented Sep 16, 2023 •

edited

Loading

CLAassistant commented Sep 16, 2023 •

edited

Loading